home *** CD-ROM | disk | FTP | other *** search
/ ShareWare OnLine 2 / ShareWare OnLine Volume 2 (CMS Software)(1993).iso / database / ind200.zip / INGENMEN.HLP < prev    next >
Text File  |  1993-02-10  |  8KB  |  143 lines
  1. ***************************************************************************
  2. ******************** HELP FOR "GENERATE INDEX" MENU ***********************
  3. ***************************************************************************
  4.  
  5. OVERVIEW: The "Generate Index" Menu includes options which enable you
  6.           to customize INDEX! operations for your particular needs, to
  7.           insert your index codes into your text files, and to strip
  8.           codes from previously-indexed files if necessary. The
  9.           individual menu options follow:
  10.  
  11. INDEX!: This is the main program. Choosing this option begins the actual
  12.         process of inserting the index codes (which you specified in the
  13.         "Terms to Index" Menu) into the Ventura text files (which you
  14.         selected in the "Files to Index" Menu). If you need to interrupt
  15.         the indexing of a series of files, you can hit the ESCAPE key, 
  16.         and you will be given the option to stop indexing and exit as
  17.         soon as the current file is completed.
  18.  
  19. SPECIAL TAGS: Sometimes you may not want index codes to be inserted into
  20.               certain kinds of paragraphs or "tags" in your Ventura text
  21.               files (as for example with running heads or running feet,
  22.               where index codes would create final index page references
  23.               to every page on which the header or footer occurs). On 
  24.               other occasions, you may wish to insert index codes ONLY
  25.               in certain paragraphs. Use this option to specify up to
  26.               twenty paragraph tags for special processing. Then use the
  27.               DEFAULTS / Process Special Tags option to tell Index! 
  28.               whether to EXCLUDE the tags, INCLUDE the tags, or ignore
  29.               the list for any given indexing session. (Note: Body text
  30.               cannot be specified for this feature.
  31.  
  32. DEFAULTS: This option enables you to customize eight INDEX! features, as
  33.           follows:
  34.          
  35.           1. Default Directory: Enter the name of the drive and directory 
  36.              is to serve as the default directory for the identification, 
  37.              location & use of Publications and/or Chapters to be indexed.
  38.              The default is the directory from which you ran INDEX!.
  39.  
  40.           2. Default Extensions: Enter the file extensions should serve as 
  41.              the defaults for INDEX! in choosing the text files to display 
  42.              for indexing when reading .CHP files in the PUBLICATIONS
  43.              or CHAPTERS option of the "Files to Index" menu. Enter a list
  44.              of extensions like this: .TXT.CAP.DOC, etc. An extensionless
  45.              file is signified by the dot; that is, the entry ..TXT.CAP
  46.              will cause Index! to look for files with no extension, .TXT
  47.              files and .CAP files. The default is .TXT.CAP.
  48.  
  49.           3. Rename Original Files: Answer YES if you want INDEX! to give
  50.              your original file names to the coded files it produces and
  51.              rename your original files with .IXT and .IXC (.CAP files
  52.              only) extensions. Answer NO if you want INDEX! to leave the
  53.              original files with the original names, and name the newly
  54.              indexed versions with the .IXT and .IXC extensions. If you
  55.              choose NO, you must later rename the indexed files before
  56.              your Ventura chapters will recognize them, or else you must
  57.              reload these files into the chapters. YES is the default.
  58.              
  59.           4. Separate Entries for .CAP Files: Answer YES if you want INDEX!
  60.              to automatically create asterisked index entries for any items
  61.              it finds in the .CAP file. This provides an easy way to 
  62.              highlight references to photos and other figures in the final
  63.              index. Answer NO if references from .CAP files should be 
  64.              the same way as other references. The default is NO.
  65.  
  66.           5. Index Cross References: Answer YES if you want INDEX! to
  67.              automatically search Ventura's cross reference codes (<$R...)
  68.              for text which should appear in your index. Index! codes will
  69.              be placed immediately ahead of the cross reference code.
  70.              Answer NO if you do not use cross references or do not wish
  71.              them to be indexed. The default is NO. Note that if you set
  72.              this option to YES, you may wish to take care in naming
  73.              variables which are part of cross reference codes, so that
  74.              variable names do not match SRCH expresssions in the Index!
  75.              database.
  76.  
  77.           6. Interpret Leading and Trailing Spaces: Answer YES if you wish
  78.              Index! to interpret leading and trailing spaces in search
  79.              phrases by doing several searches, each of which will 
  80.              substitute a different character which could reasonably exist
  81.              in the text in place of the spacebar. Answer NO if you do not
  82.              wish Index! to do multiple searches for expressions with
  83.              leading and trailing spaces. The default is NO.
  84.  
  85.              When you choose YES, INDEX! automatically performs the
  86.              following alternative searches when it encounters leading
  87.              and/or trailing spaces in SRCH expressions:
  88.  
  89.              For a leading space, INDEX! uses the spacebar plus these:
  90.  
  91.                        '      >      (
  92.  
  93.              For a trailing space, INDEX! uses the spacebar plus these:
  94.  
  95.                        ;      '      :      )      ,      .      <
  96.  
  97.              When there are both leading and trailing spaces, INDEX!
  98.              uses a subset of the two sets above, searching for every
  99.              combination of spacebars plus:
  100.  
  101.                   Leading:     >
  102.                   Trailing:    ,      .      <
  103.  
  104.                   
  105.           7. Exclude Tables: Answer YES to exclude Ventura tables from
  106.              the indexing process. If you do not need to index your tables,
  107.              the YES option causes Index! to run somewhat faster. Also, if
  108.              you experience any difficulties in loading tables after 
  109.              indexing, you should return to your original files and 
  110.              reindex them with this option set to YES. If you answer NO,
  111.              Index! will index your table text in the usual way. (Note:
  112.              Index! always excludes all table formatting paragraphs from
  113.              indexing.)
  114.  
  115.           8. Process Special Tags: Answer EXCLUDE if you wish Index! to
  116.              exclude from indexing any paragraphs which have any of the
  117.              tags you listed under SPECIAL TAGS. Answer INCLUDE to restrict
  118.              Index! to inserting codes in ONLY the paragraphs listed under
  119.              SPECIAL TAGS. Answer NO to make Index! ignore the special tag
  120.              list and process everything in the normal way. The default is
  121.              NO. (Note: Body text cannot be specified for this feature.)
  122.  
  123. CODE STRIPPER: If you add index codes to the wrong text file, or add index
  124.                codes which are incorrect, outdated, or in the way of
  125.                further editing, you can strip the codes from the text file
  126.                with this option, returning the file to its original
  127.                condition. You can either specify one file at a time for 
  128.                code stripping or you can type in the word "ALL" instead of
  129.                a file name to strip all the text files in your current
  130.                project (as selected in the FILES TO INDEX menu). Files to
  131.                be stripped must be on the same disk drive as INDEX!.
  132.  
  133. HELP: This option provides the on-screen information which you are now
  134.       reading.
  135.  
  136. MORE HELP: If you would like to have more help online relating to the
  137.            GENERATE INDEX menu, you can edit the file "INGENMEN.HLP" in
  138.            any ASCII text editor, adding to or reshaping the material as
  139.            you see fit up to a maximum file size of 64K. Use spaces rather
  140.            than tabs to indent, limit line lengths to 76 characters, and
  141.            end each and every line with a carriage return.
  142.  
  143.